home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_hylafax.idb / usr / freeware / catman / u_man / cat1 / faxcover.Z / faxcover
Text File  |  2002-07-08  |  11KB  |  206 lines
  1. FAXCOVER(1)                          FAXCOVER(1)
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        faxcover     - generate a POSTSCRIPT cover page for    an outgo
  7.        ing facsimile
  8.  
  9. SSYYNNOOPPSSIISS
  10.        ffaaxxccoovveerr    [ _o_p_t_i_o_n_s ] --ff _f_r_o_m_-_n_a_m_e --nn _f_a_x_-_n_u_m_b_e_r
  11.  
  12. DDEESSCCRRIIPPTTIIOONN
  13.        _f_a_x_c_o_v_e_r    generates a POSTSCRIPT cover  page  document  on
  14.        the standard output.  The cover page fills the entire area
  15.        of a default page and is    created    according to the informa
  16.        tion  supplied  on the command line and a _c_o_v_e_r _s_h_e_e_t _t_e_m_
  17.        _p_l_a_t_e file.
  18.  
  19.        _f_a_x_c_o_v_e_r    is normally invoked by the _s_e_n_d_f_a_x(1) program  to
  20.        generate    a cover    page for each outgoing facsmile.
  21.  
  22.        _f_a_x_c_o_v_e_r     works    by  creating a POSTSCRIPT dictionary that
  23.        contains    definitions for    the variable information that  is
  24.        to be placed on the facsimile cover page.  Specifically,    a
  25.        dictionary with the following symbols are defined:
  26.        SSyymmbbooll          DDeessccrriippttiioonn                 SSyymmbbooll          DDeessccrriippttiioonn
  27.        _t_o          destination person             _f_r_o_m          _s_e_n_d_i_n_g person
  28.        _t_o_-_c_o_m_p_a_n_y      destination company             _f_r_o_m_-_c_o_m_p_a_n_y      sender's company
  29.        _t_o_-_l_o_c_a_t_i_o_n      destination geographic location    _f_r_o_m_-_l_o_c_a_t_i_o_n      sender geographic location
  30.        _t_o_-_v_o_i_c_e_-_n_u_m_b_e_r      person's voice phone number         _f_r_o_m_-_v_o_i_c_e_-_n_u_m_b_e_r      sender's voice phone number
  31.        _t_o_-_f_a_x_-_n_u_m_b_e_r      destination fax phone    number         _f_r_o_m_-_f_a_x_-_n_u_m_b_e_r      sender's fax phone number
  32.        _c_o_m_m_e_n_t_s          unbroken comment string         _c_o_m_m_e_n_t_s_X          _X'th line of comments
  33.        _r_e_g_a_r_d_i_n_g      Re: subject                 _C_o_m_m_e_n_t_X          similar to _c_o_m_m_e_n_t_s_X
  34.        _p_a_g_e_W_i_d_t_h      page width in    millimeters         _p_a_g_e_-_c_o_u_n_t          # pages other    than cover page
  35.        _p_a_g_e_L_e_n_g_t_h      page length in millimeters         _t_o_d_a_y_s_-_d_a_t_e      current date and time
  36.  
  37.        If the _c_o_m_m_e_n_t_s string is longer    than _m_a_x_l_e_n_c_o_m_m_e_n_t_s char
  38.        acters,    it  is broken, on word boundaries or instances of
  39.        ``\n, into multiple POSTSCRIPT strings _c_o_m_m_e_n_t_s_X    where _X
  40.        is the line number; e.g.     _c_o_m_m_e_n_t_s_2 for the second line of
  41.        comments.  Long substrings without whitespace which exceed
  42.        _m_a_x_l_e_n_c_o_m_m_e_n_t_s  are  also broken. By default _f_a_x_c_o_v_e_r will
  43.        generate    20 _c_o_m_m_e_n_t_s_X strings, emitting null string values
  44.        for  empty  lines.  This    number can be changed with the --mm
  45.        option; see below.  _m_a_x_l_e_n_c_o_m_m_e_n_t_s is changed with the  --zz
  46.        option; see below.
  47.  
  48.        Note  that use of _c_o_m_m_e_n_t_s_X with    non-fixed-width    fonts can
  49.        lead to spatial problems    where characters run off the edge
  50.        of the generated    cover page.  In    such cases, use    of _B_r_e_a_k_
  51.        _I_n_t_o_L_i_n_e_s (see below) may be a more suitable approach.
  52.  
  53.        _C_o_m_m_e_n_t_X    is similar to _c_o_m_m_e_n_t_s_X    except    that  its  values
  54.        are  created  only  by  breaking     _c_o_m_m_e_n_t_s on instances of
  55.        ``\n and    not otherwise.    _m_a_x_l_i_n_e_s does not  affect  _C_o_m_
  56.        _m_e_n_t_X
  57.  
  58.        _f_a_x_c_o_v_e_r     also  emits  a    POSTSCRIPT procedure for breaking
  59.        comment strings into multiple lines using  the  POSTSCRIPT
  60.        font metric information.     This procedure    is named _B_r_e_a_k_I_n_
  61.        _t_o_L_i_n_e_s and has the following usage convention:
  62.  
  63.        %<line-width> <line-height> <x>    <y>  <string>  BreakInto
  64.        Lines -
  65.  
  66.        eg
  67.           /rule (_____________________________________________) def
  68.           /lw rule stringwidth pop def /lh 30 def
  69.           /y 191.4 def /x 0    def
  70.           y    -30 0 {    x exch moveto rule show    } for
  71.           lw lh x y    comments BreakIntoLines
  72.        where  the  width  of the rule controls the length of each
  73.        line of comments    (note that it is  made    slightly  shorter
  74.        here  for  the  purpose of presentation), _x and _y are ini
  75.        tialized    to coordinate locations    on  the     page  where  the
  76.        comment    string should be imaged, and the number    30 is the
  77.        inter-line spacing appropriate for the font used    to  image
  78.        the comment lines.
  79.  
  80.        If  information is unavailable for an item, the associated
  81.        POSTSCRIPT symbol is defined to be a null string.
  82.  
  83.        Following the definition    prologue, a cover sheet     template
  84.        file  is    copied.     This file is expected to be a POSTSCRIPT
  85.        program that uses the generated strings to create a  cover
  86.        page.   The  template  must include a sshhoowwppaaggee operator to
  87.        cause the page to be imaged.  The above    symbols     will  be
  88.        defined    in the _c_u_r_r_e_n_t _d_i_c_t_i_o_n_a_r_y.  A trailing eenndd opera
  89.        tor is supplied by _f_a_x_c_o_v_e_r, so any  manipulation  of  the
  90.        dictionary  stack  should  leave    the current dictionary on
  91.        the top of the stack on completion.
  92.  
  93. OOPPTTIIOONNSS
  94.        --cc _c_o_m_m_e_n_t_s Use _c_o_m_m_e_n_t_s    for the    comment    string.     You  may
  95.            use    '\n'  to  break     it into several lines on
  96.            generated the cover page.
  97.  
  98.        --CC _f_i_l_e       Use _f_i_l_e as the template  file.   The  default
  99.            template  file is named _f_a_x_c_o_v_e_r_._p_s.     The tem
  100.            plate file can also be  specified  by  setting
  101.            the    FAXCOVER  environment  variable.   If the
  102.            template filename is    not an absolute    pathname,
  103.            then    _f_a_x_c_o_v_e_r looks first for this file in the
  104.            home    directory of the sender.  If no    such file
  105.            is  present,     then  it  looks  in  the library
  106.            directory where the _H_y_l_a_F_A_X client application
  107.            data     are  installed.   If no template file is
  108.            located, _f_a_x_c_o_v_e_r will terminate without  gen
  109.            erating a cover page.
  110.  
  111.        --DD _f_o_r_m_a_t   Use    _f_o_r_m_a_t    as  the     formatting specification
  112.            passed to _s_t_r_f_t_i_m_e(3) when generating the time
  113.            and date placed on the cover    page.
  114.  
  115.        --ff _n_a_m_e       Use _n_a_m_e for    the sender's identity.
  116.  
  117.        --ll _l_o_c_a_t_i_o_n Use    _l_o_c_a_t_i_o_n  for  the geographic location of
  118.            the destination company.
  119.  
  120.        --LL _l_o_c_a_t_i_o_n Use _l_o_c_a_t_i_o_n    for the     geographic  location  of
  121.            the sender's    company.
  122.  
  123.        --mm _m_a_x_l_i_n_e_s indicates  the  maximum  number  of    _c_o_m_m_e_n_t_s_X
  124.            lines to generate.
  125.  
  126.        --nn _n_u_m_b_e_r   Use _n_u_m_b_e_r for  the    destination  fax  machine
  127.            number.
  128.  
  129.        --NN _n_u_m_b_e_r   Use    _n_u_m_b_e_r    for the    sender's fax machine num
  130.            ber.
  131.  
  132.        --pp _c_o_u_n_t       Use _c_o_u_n_t for the count of pages to follow the
  133.            cover page.
  134.  
  135.        --rr _r_e_g_a_r_d_i_n_g
  136.            Use _r_e_g_a_r_d_i_n_g for the ``Re:'' field.
  137.  
  138.        --ss _s_i_z_e       Set    the  page size to use for the transmitted
  139.            facsimile.  Facsimile are normally imaged with
  140.            a  system-default  page  size (usually letter-
  141.            size    pages, 8.5" by 11", for     sites    in  North
  142.            America).   Alternate page sizes are    specified
  143.            symbolically    using either the name or abbrevi
  144.            ation  of  an  entry     in  the _p_a_g_e_s_i_z_e_s(${MAN
  145.            NUM4_5}) database; e.g.  _a_3 (ISO A3), _a_4  (ISO
  146.            A4),     _a_5  (ISO  A5),    _a_6 (ISO    A6), _b_4    (ISO B4),
  147.            _n_a_-_l_e_t (North American Letter), _u_s_-_l_e_g (Ameri
  148.            can    Legal),     _u_s_-_l_e_d    (American Ledger), _u_s_-_e_x_e
  149.            (American Executive),  _j_p_-_l_e_t  (Japanese  Let
  150.            ter),  and  _j_p_-_l_e_g  (Japanese Legal).  Compar
  151.            isons are case-insensitive and any match of    a
  152.            substring of    the full page-size name    is suffi
  153.            cient; e.g. ``legal'' would    match  ``American
  154.            Legal''.
  155.  
  156.            Note     that  it may not be permissible to image
  157.            into    the full page area; the    guaranteed repro
  158.            ducible  area  for  a page is typically inset.
  159.            Also, note that while arbitrary page    sizes can
  160.            be  specified  through the page size    database,
  161.            only    a limited set of page dimensions are sup
  162.            ported  by  the  Group  3  facsimile    protocol.
  163.            Thus    if an odd-size facsimile is submitted for
  164.            transmission     it may    not be possible    to deter
  165.            mine    if it can be sent until     the  fax  server
  166.            establishes communication with the remote fac
  167.            simile machine.
  168.  
  169.        --tt _n_a_m_e       Use _n_a_m_e for    the receiver's identity.
  170.  
  171.        --vv _n_u_m_b_e_r   Use _n_u_m_b_e_r for the receiver's voice phone num
  172.            ber.
  173.  
  174.        --VV _n_u_m_b_e_r   Use    _n_u_m_b_e_r    for the    sender's voice phone num
  175.            ber.
  176.  
  177.        --xx _c_o_m_p_a_n_y  Use _c_o_m_p_a_n_y for the destination company  name.
  178.  
  179.        --XX _c_o_m_p_a_n_y  Use _c_o_m_p_a_n_y for the sender's    company    name.
  180.  
  181.        --zz _m_a_x_l_e_n_c_o_m_m_e_n_t_s
  182.            indicates  the  maximum  length  in    number of
  183.            characters allowed in a _c_o_m_m_e_n_t_s_X string.
  184.  
  185. DDIIAAGGNNOOSSTTIICCSS
  186.        Complaints about    not being able to locate a template file.
  187.  
  188. FFIILLEESS
  189.        ~/.faxdb             personal fax number database
  190.        ~/.hylarc         per-user configuration    file
  191.        ${LIBDATA}/hyla.conf     system-wide configuration file
  192.        ${LIBDATA}/faxcover.ps     default cover page template
  193.        ${LIBDATA}/pagesizes     page size database
  194.  
  195. BBUUGGSS
  196.        _f_a_x_c_o_v_e_r     should     be  able  to  determine  the appropriate
  197.        length of _c_o_m_m_e_n_t_s_X strings by using font metric     informa
  198.        tion.
  199.  
  200. SSEEEE AALLSSOO
  201.        _h_y_l_a_f_a_x_-_c_l_i_e_n_t(1), _s_e_n_d_f_a_x(1)
  202.  
  203.  
  204.  
  205.              January 06, 2001          FAXCOVER(1)
  206.